/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Microsoft Corporation
 * 
 * -=- Robust Distributed System Nucleus (rDSN) -=- 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/*
 * Description:
 *     What is this file about?
 *
 * Revision history:
 *     xxxx-xx-xx, author, first version
 *     xxxx-xx-xx, author, fix bug about xxx
 */

# pragma once

# include "service_engine.h"
# include <dsn/tool-api/task_queue.h>
# include <dsn/tool-api/admission_controller.h>
# include <dsn/tool-api/perf_counter.h>
# include <dsn/tool-api/task_worker.h>
# include <dsn/tool-api/timer_service.h>

namespace dsn {

class task_engine;
class task_worker_pool;
class task_worker;

//
// a task_worker_pool is a set of TaskWorkers share the same configs;
// they may even share the same task_queue when partitioned == false
//
class task_worker_pool
{
public:
    task_worker_pool(const threadpool_spec& opts, task_engine* owner);

    // service management
    void create();    
    void start();

    // task procecessing
    void enqueue(task* task);
    void on_dequeue(int count);

    // cached timer service access
    void add_timer(task* task);

    // inquery
    const threadpool_spec& spec() const { return _spec; }
    bool shared_same_worker_with_current_task(task* task) const;
    task_engine* engine() const { return _owner; }
    service_node* node() const { return _node; }
    void get_runtime_info(const safe_string& indent, const safe_vector<safe_string>& args, /*out*/ safe_sstream& ss);
    void get_queue_info(/*out*/ safe_sstream& ss);
    std::vector<task_queue*>& queues() { return _queues; }
    std::vector<task_worker*>& workers() { return _workers; }
    std::vector<admission_controller*>& controllers() { return _controllers; }

private:
    threadpool_spec                    _spec;
    task_engine*                       _owner;
    service_node*                      _node;

    std::vector<task_worker*>          _workers;
    std::vector<task_queue*>           _queues;    
    std::vector<admission_controller*> _controllers;

    // cached ptrs for fast access
    timer_service*                     _per_node_timer_svc;
    std::vector<timer_service*>        _per_queue_timer_svcs;

    bool                              _is_running;
};

class task_engine
{
public:
    task_engine(service_node* node);

    //
    // service management routines
    //
    void create(const safe_list<dsn_threadpool_code_t>& pools);
    void start();

    //
    // task management routines
    //
    task_worker_pool* get_pool(int code) const { return _pools[code]; }
    std::vector<task_worker_pool*>& pools() { return _pools; }

    bool is_started() const { return _is_running; }

    volatile int* get_task_queue_virtual_length_ptr(
        dsn_task_code_t code,
        int hash
        );

    service_node* node() const { return _node; }
    void get_runtime_info(const safe_string& indent, const safe_vector<safe_string>& args, /*out*/ safe_sstream& ss);
    void get_queue_info(/*out*/ safe_sstream& ss);
private:
    std::vector<task_worker_pool*> _pools;
    volatile bool                  _is_running;
    service_node                   *_node;
};

// -------------------- inline implementation ----------------------------

} // end namespace
